|
In computer programming, self-documenting (or self-describing) source code and user interfaces follow naming conventions and structured programming conventions that enable use of the system without prior specific knowledge.〔 〕〔(See e.g., Use–mention distinction, Naming collision, Polysemy)〕 Self-documenting code most prominently, perhaps notoriously, uses very long names - that is to say, whole sentences - for variables, classes, and other identifiers. Whereas a variable or property may be simply "i" or "x" in conventional code, a whole-sentence name such as "WhichRowOfTheTableWeAreGenerating" or "theIndexOfTheLastItemWeWillProcess" would be used in self-documenting code. ==Objectives== Commonly stated objectives for self-documenting systems include: * Make source code easier to read and understand * Minimize the effort required to maintain or extend legacy systems * Reduce the need for users and developers of a system to consult secondary documentation sources such as code comments or software manuals * Facilitate automation through self-contained knowledge representation 抄文引用元・出典: フリー百科事典『 ウィキペディア（Wikipedia）』 ■ウィキペディアで「Self-documenting」の詳細全文を読む スポンサード リンク
|